Improve development environment setup instructions - #262
Conversation
There was a problem hiding this comment.
Pull request overview
This PR aims to improve the development environment setup documentation by adding instructions for creating a virtual environment, installing neural-lam in editable mode with dev dependencies, and running the test suite. It also updates dependency constraints for numpy and xarray to resolve compatibility issues.
Changes:
- Added a "Development Environment Setup" section to README with installation and testing instructions
- Added upper bound constraint to numpy (
<2) to avoid breaking changes in numpy 2.0 - Added xarray version constraint to address zarr v3 compatibility issues
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Added development environment setup section with virtual environment creation, installation, and testing instructions |
| pyproject.toml | Updated numpy constraint to exclude v2.0+, added xarray version constraint |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
c18dc28 to
c3cbd9c
Compare
c3cbd9c to
f454f5b
Compare
|
@sadamov @observingClouds kindly review this PR . Thankyou sir |
1 similar comment
|
@sadamov @observingClouds kindly review this PR . Thankyou sir |
|
Please note that parts of the checklists shall only be filled by the reviewer and assignee as they will need to check your PR. A changelog entry is for example missing even though the tick was set. |
|
I don't even see the PR template being used here. Please edit the PR to use that. Some thoughts about the PR content: I don't think we need to instruct people on how to set up a virtual env. Could maybe just add a link to instructions about this. There are instructions about how to install in editable mode in the general install instructions. It would be better to not duplicate these, so if we want to add this to the dev section of the README we should move it from there. The instruction to check the env by running all tests is good. |
sadamov
added
documentation
|
@ashum9 I saw your recent commits here and just wanted to ask again that you would revert to the original PR template. thanks! |
|
Closing this one. Per @joeloskarsson's feedback, we don't need venv setup instructions in the main README. Contributor onboarding is now covered by the new CONTRIBUTING.md from #407. Thanks @ashum9 for the contribution. |
Summary
Adds a Development Environment Setup section to README.md under the Development and Contributing heading.
This section provides clear steps for setting up a local development environment, including:
Creating a virtual environment using python -m venv
Activation instructions for:
Linux/macOS
Windows Command Prompt
Windows PowerShell
Installing neural-lam in editable mode using pip install --group dev -e .
Verifying the installation by running pytest
These instructions simplify onboarding for new contributors by providing a straightforward and reproducible setup process.
Closes #261